<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:14 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>GraphView (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="GraphView (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GraphView.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/graph/api/GraphSettings.html" title="interface in org.gephi.graph.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/graph/api/Group.html" title="interface in org.gephi.graph.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/graph/api/GraphView.html" target="_top">Frames</a></li>
<li><a href="GraphView.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.graph.api</div>
<h2 title="Interface GraphView" class="title">Interface GraphView</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">GraphView</span></pre>
<div class="block">Graph view define a <b>subgraph</b>, i.e. a subset of the original graph.
 <code>GraphModel</code> has at least a single view, called the <b>main</b>
 view, which contains 100% of the graph. Other views can be defined by users
 to define subgraphs with a reduced number of nodes and edges. This is typically
 used by filters, which returns filtered graphs.
 <p>
 <code>GraphModel</code> also contains the <b>visible</b> view, which is the
 main view by default but can be set to configure the view that is visualized.
 <p>
 What exactly contains the view? The complete hierarchy of nodes, the edges
 and meta-edges. Each view has separate hierarchy, therefore grouping and
 meta-edges are independent.
 <p>
 Note that nodes' id is unique, and is not touched by views.
 <h3>Main or Visible View?</h3>
 When you need to interact with the graph structure, you have the choice
 between working on the complete graph, i.e. the <b>main</b> view, or the
 <b>visible</b> view. In most cases, it's preferable to use the <b>visible</b>
 view because your action will use the graph currently visualized, which has
 been potentially filtered by users on purpose.
 <p>
 To get the graph in the visible view, see <a href="../../../../org/gephi/graph/api/GraphModel.html#getGraphVisible()"><code>GraphModel.getGraphVisible()</code></a>.
 <h3>Set the Visible View</h3>
 This is the typical workflow for filtering a graph and display the results,
 as done by <code>FiltersAPI</code>.
 <ul><li>Create a new view, which duplicates the <b>main</b> view, with all
 nodes and edges in it.</li>
 <li>Remove nodes and edges in the view.</li>
 <li>Set the view as the currently visible view.</li></ul>
 To set a view as the currently visible view, see
 <a href="../../../../org/gephi/graph/api/GraphModel.html#setVisibleView(org.gephi.graph.api.GraphView)"><code>GraphModel.setVisibleView(org.gephi.graph.api.GraphView)</code></a>.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Mathieu Bastian</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/graph/api/GraphModel.html" title="interface in org.gephi.graph.api">GraphModel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/GraphView.html#getGraphModel()">getGraphModel</a></strong>()</code>
<div class="block">Returns the graph model this view belongs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/GraphView.html#getViewId()">getViewId</a></strong>()</code>
<div class="block">Returns this view unique identifier.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/GraphView.html#isMainView()">isMainView</a></strong>()</code>
<div class="block">Returns <code>true</code> if this view is the main view.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getViewId()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getViewId</h4>
<pre>int&nbsp;getViewId()</pre>
<div class="block">Returns this view unique identifier. The id is a positive integer. The
 main view always has it's id equal to zero.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the view identifier</dd></dl>
</li>
</ul>
<a name="isMainView()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMainView</h4>
<pre>boolean&nbsp;isMainView()</pre>
<div class="block">Returns <code>true</code> if this view is the main view. Each
 <code>GraphModel</code> has a single main view, which contains all nodes
 and edges in the model.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this is the main view, <code>false</code>
 otherwise.</dd></dl>
</li>
</ul>
<a name="getGraphModel()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getGraphModel</h4>
<pre><a href="../../../../org/gephi/graph/api/GraphModel.html" title="interface in org.gephi.graph.api">GraphModel</a>&nbsp;getGraphModel()</pre>
<div class="block">Returns the graph model this view belongs.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the graph model this view belongs.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GraphView.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/graph/api/GraphSettings.html" title="interface in org.gephi.graph.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/graph/api/Group.html" title="interface in org.gephi.graph.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/graph/api/GraphView.html" target="_top">Frames</a></li>
<li><a href="GraphView.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
